<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ReadableInstant xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/goda/time/ReadableInstant.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2005 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment">/**</em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * Defines an instant in the datetime continuum.</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * This interface expresses the datetime as milliseconds from 1970-01-01T00:00:00Z.</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * The implementation of this interface may be mutable or immutable.</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * This interface only gives access to retrieve data, never to change it.</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * Methods in your application should be defined using &lt;code&gt;ReadableInstant&lt;/code&gt;</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * as a parameter if the method only wants to read the instant without needing to know</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * the specific datetime fields.</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> *</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> */</em>
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> <strong class="jxr_keyword">extends</strong> Comparable {
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>      <em class="jxr_javadoccomment">/**</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">     * Get the value as the number of milliseconds since</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment">     * the epoch, 1970-01-01T00:00:00Z.</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">     *</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment">     * @return the value as milliseconds</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">     */</em>
<a name="40" href="#40">40</a>      <strong class="jxr_keyword">long</strong> getMillis();
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>      <em class="jxr_javadoccomment">/**</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     * Gets the chronology of the instant.</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     * The {@link Chronology} provides conversion from the millisecond</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     * value to meaningful fields in a particular calendar system.</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     * </em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     * @return the Chronology, never null</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     */</em>
<a name="50" href="#50">50</a>      <a href="../../../org/goda/time/Chronology.html">Chronology</a> getChronology();
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>      <em class="jxr_javadoccomment">/**</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     * Gets the time zone of the instant from the chronology.</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     * </em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     * @return the DateTimeZone that the instant is using, never null</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     */</em>
<a name="57" href="#57">57</a>      <a href="../../../org/goda/time/DateTimeZone.html">DateTimeZone</a> getZone();
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>      <em class="jxr_javadoccomment">/**</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * Get the value of one of the fields of a datetime.</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * This method uses the chronology of the instant to obtain the value.</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     *</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     * @param type  a field type, usually obtained from DateTimeFieldType, not null</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     * @return the value of that field</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the field type is null</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">     */</em>
<a name="68" href="#68">68</a>      <strong class="jxr_keyword">int</strong> get(<a href="../../../org/goda/time/DateTimeFieldType.html">DateTimeFieldType</a> type);
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      <em class="jxr_javadoccomment">/**</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     * Checks whether the field type specified is supported by this implementation.</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     *</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * @param field  the field type to check, may be null which returns false</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * @return true if the field is supported</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     */</em>
<a name="76" href="#76">76</a>      <strong class="jxr_keyword">boolean</strong> isSupported(<a href="../../../org/goda/time/DateTimeFieldType.html">DateTimeFieldType</a> field);
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>      <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="79" href="#79">79</a>      <em class="jxr_javadoccomment">/**</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     * Get the value as a simple immutable &lt;code&gt;Instant&lt;/code&gt; object.</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * This can be useful if you don't trust the implementation</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * of the interface to be well-behaved, or to get a guaranteed</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * immutable object.</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     *</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * @return the value as an &lt;code&gt;Instant&lt;/code&gt; object</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     */</em>
<a name="88" href="#88">88</a>      <a href="../../../org/goda/time/Instant.html">Instant</a> toInstant();
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>      <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="91" href="#91">91</a>      <em class="jxr_javadoccomment">/**</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * Compares this object with the specified object for ascending</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * millisecond instant order. This ordering is inconsistent with</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * equals, as it ignores the Chronology.</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     * All ReadableInstant instances are accepted.</em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     *</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * @param readableInstant  a readable instant to check against</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * @return negative value if this is less, 0 if equal, or positive value if greater</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * @throws NullPointerException if the object is null</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * @throws ClassCastException if the object type is not supported</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     */</em>
<a name="103" href="#103">103</a>     <strong class="jxr_keyword">int</strong> compareTo(Object readableInstant);
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="106" href="#106">106</a>     <em class="jxr_javadoccomment">/**</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">     * Is this instant equal to the instant passed in</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     *</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * @param instant  an instant to check against, null means now</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * @return true if the instant is equal to the instant passed in</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     */</em>
<a name="113" href="#113">113</a>     <strong class="jxr_keyword">boolean</strong> isEqual(<a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant);
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     <em class="jxr_javadoccomment">/**</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     * Is this instant after the instant passed in</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     *</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * @param instant  an instant to check against, null means now</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * @return true if the instant is after the instant passed in</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     */</em>
<a name="122" href="#122">122</a>     <strong class="jxr_keyword">boolean</strong> isAfter(<a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant);
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>     <em class="jxr_javadoccomment">/**</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * Is this instant before the instant passed in</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     *</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * @param instant  an instant to check against, null means now</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * @return true if the instant is before the instant passed in</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     */</em>
<a name="131" href="#131">131</a>     <strong class="jxr_keyword">boolean</strong> isBefore(<a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant);
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="134" href="#134">134</a>     <em class="jxr_javadoccomment">/**</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * Compares this object with the specified object for equality based</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     * on the millisecond instant and the Chronology. All ReadableInstant</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     * instances are accepted.</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * To compare two instants for absolute time (ie. UTC milliseconds </em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * ignoring the chronology), use {@link #isEqual(ReadableInstant)} or</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * {@link #compareTo(Object)}.</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     *</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * @param readableInstant  a readable instant to check against</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * @return true if millisecond and chronology are equal, false if</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     *  not or the instant is null or of an incorrect type</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     */</em>
<a name="147" href="#147">147</a>     <strong class="jxr_keyword">boolean</strong> equals(Object readableInstant);
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>     <em class="jxr_javadoccomment">/**</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * Gets a hash code for the instant that is compatible with the </em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * equals method.</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * The formula used must be as follows:</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * ((int) (getMillis() ^ (getMillis() &gt;&gt;&gt; 32))) +</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     * (getChronology().hashCode())</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     *</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * @return a hash code as defined above</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     */</em>
<a name="161" href="#161">161</a>     <strong class="jxr_keyword">int</strong> hashCode();
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="164" href="#164">164</a>     <em class="jxr_javadoccomment">/**</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     * Get the value as a String in a recognisable ISO8601 format.</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * The string output is in ISO8601 format to enable the String</em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * constructor to correctly parse it.</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     *</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * @return the value as an ISO8601 string</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     */</em>
<a name="172" href="#172">172</a>     String toString();
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

